home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / mint / editors / mjovesrc.zoo / readme.mac < prev    next >
Text File  |  1990-09-29  |  18KB  |  411 lines
  1. /***************************************************************************
  2.  * This program is Copyright (C) 1986, 1987, 1988 by Jonathan Payne.  JOVE *
  3.  * is provided to you without charge, and with no warranty.  You may give  *
  4.  * away copies of JOVE, including sources, provided that this notice is    *
  5.  * included in all the files.                                              *
  6.  ***************************************************************************/
  7.  
  8. Changes between 4.9 and 4.10:
  9.  
  10.   New features:
  11.     1) Reshapeable windows with zoom boxes.
  12.     2) Filename/directory name completion with macify OFF.
  13.     3) Double click mouse to set the mark.
  14.     4) Control-space and control-@ correctly send NUL on MacII/SE.
  15.     5) Control-` fixed to send backquote char.
  16.     6) Display update code fixed.
  17.     
  18.   Sources:
  19.     1) Compiles under LSC 3.0. (Probably under 2.13 as well, but
  20.        not tested with that version).
  21.     2) Include files redone, with fewer total lines of code.
  22.     3) No need to modify include files, unless NBUF changed.
  23.     4) "keymaps.txt" is now "keys.txt".
  24.     
  25.   Planned:
  26.     1) Recover command as separate application.
  27.     2) Support for MPW compiler vers 2.02.
  28.     
  29.    
  30. Introduction
  31.  
  32. This file contains a brief description of MacJove, along with
  33. information necessary to make MacJove from the source files.
  34. It is assumed that the reader is familiar with Jove from other
  35. systems, and is somewhat familiar with the Macintosh as well. In
  36. the future there may be a separate user's manual for MacJove: 
  37. for the time being, the reader should refer to the Jove manual
  38. for Unix users.
  39.  
  40. Description
  41.  
  42. MacJove is a direct port of Jove to the Macintosh, with the
  43. overall structure, commands and key bindings left intact. In
  44. addition, elements of the Macintosh user interface - menus,
  45. window controls, and the mouse, have been integrated in a manner
  46. consistent with the overall functioning of Jove.
  47.  
  48. While the integration of these tools into the Jove environment
  49. is consistent and, to most users, familiar, Jove departs in
  50. several places from "Macintosh User Interface Guidelines". Most
  51. notably, the mouse is used to position the point only, not to
  52. drag or select text, and the Jove buffer structure is not
  53. integrated with the clipboard. Also, key bindings conform to
  54. Jove/Emacs tradition, and not to Macintosh guidelines: i.e.
  55. control (command)-N is next-line, not "NewFile". The reason for
  56. these departures is that the majority of MacJove users are likely
  57. to be those already familiar with Jove or other Emacs editors
  58. on other systems, and for these users, consistency between machines
  59. and operating systems is more important than fully exploiting
  60. the features of a single system. There are numerous other text
  61. editors which fully follow the Macintosh User Interface Guidelines.
  62.  
  63. MacJove retains most features of other Joves, but certain commands
  64. cannot be implemented because of the Macintosh operating system.
  65. Thus, there is no way to run a sub-process or a shell in a window,
  66. because there are no shells to run on the Macintosh, and a program
  67. (currently) can only transfer control to another program, not run
  68. a child process. For similar reasons, commands dealing with mail,
  69. with running make, and checking errors, are omitted.
  70.  
  71.  
  72.  
  73.                       Running MacJove
  74.  
  75. System Requirements
  76.  
  77. MacJove should run without difficulty on any Macintosh Plus, SE, or
  78. Macintosh II, providing that the hierarchical file system (HFS) is used, and
  79. assuming a reasonably current system file is used. An upgraded 512K Mac
  80. (with 128K rom) should also work if there is enough memory.  MacJove was
  81. developed on a Macintosh Plus and Macintosh II running system 4.2 and Finder
  82. 6.0., and has not been fully tested on earlier systems - however, it is
  83. likely that it will run on system 3.2 and later versions. MacJove has been
  84. used to a limited extent with Switcher and under Multifinder. In both cases,
  85. it is important to reserve enough memory for MacJove, as discussed below.
  86.  
  87. MacJove, as compiled from the sources, uses memory as follows:
  88.  
  89.    Program Code     approx 116K
  90.    Static Data      approx  20K
  91.    Tempfile Cache           64K (heap)
  92.                            ____
  93.                            200K total before stack/heap considerations
  94.  
  95. To this must be added stack and heap space. A bare minimum for this is
  96. probably 100K or so, but the usage will vary as buffers are created.  With
  97. Jove, the file itself takes up space only in the tempfile and its cache, but
  98. the buffer structure requires 3 pointers (12 bytes) for each line in the
  99. file. For a reasonable editing session with files totalling, say 10000 to
  100. 20000 lines, this additional space can add up. For this reason, it is
  101. unrealistic to expect to run Jove on a 512K system, unless a very small
  102. system file is used, few, small files are edited each session, and the
  103. tempfile cache is reduced (see cache size under Making Jove). You can
  104. experiment with various memory allocations under Switcher and Multifinder to
  105. see what works with your editing habits (backup your files first!), but a
  106. realistic minimum is 400K - 500K and more is great.
  107.  
  108. When first using MacJove, and if memory space is questionable, SAVE YOUR
  109. FILES FREQUENTLY. If it is necessary to edit many files, it is often better
  110. to exit MacJove and restart once in a while, especially if there is a
  111. question of limited memory.
  112.  
  113. Operation
  114.  
  115.  
  116. Running MacJove is similar to other Macintosh applications, and should be
  117. intuitive. You start up MacJove by either opening, or double-clicking,
  118. the MacJove icon. If you have previously saved files created with MacJove,
  119. double-clicking on them will also start up the program, and the files will
  120. be put into buffers. Several files can be selected simultaneously by this
  121. method. There is no current way to select command-line options with
  122. MacJove, but this may change in the future.
  123.  
  124. The .joverc file, if used, must be present in the same directory as MacJove,
  125. the "home" directory. The help file, "cmds.doc", must also be in this
  126. directory. The tempfile, ".joveXXX", will be placed in whatever directory is
  127. current when the tempfile is first opened - this may or may not be the home
  128. directory, and may change in the future. The recover file, ".jrecXXX" is
  129. placed in the home directory. While this file is created and updated as on
  130. Unix versions of Jove, there is currently no "recover" program for MacJove.
  131. Hopefully, this will be available soon.
  132.  
  133. MacJove can edit any text file on the Macintosh, whether created with
  134. MacJove or another editor. It cannot be used to edit graphics material, and
  135. graphics material cannot be inserted during operation of MacJove. Files
  136. created with MacJove are of type 'TEXT' and of signature 'JV01'. This
  137. signature is being registered with Apple, and may change if necessary. Note
  138. that once MacJove files have been re-edited with another editor, they likely
  139. will have new signatures, and double-clicking on them will start the other
  140. editor, not MacJove.
  141.  
  142. The standard Macintosh keyboard is inadequate for MacJove (and most anything
  143. else), so that it is necessary to change a couple of keys. The "`" key
  144. becomes the ESCAPE key, since it is in the right place for one: to send a
  145. real "'", hold the command key down while typing it. The command key is used
  146. for a control key - unfortunately, the location of it is horrible for such a
  147. purpose. On Macintosh SE and Macintosh II models, a real escape key exists,
  148. and also a real control key. Note, however, that because of a small bug in
  149. the keyboard encoding in MacJove, you cannot directly send a NUL (control-@)
  150. with the control key. Typing command-@ or command-2 will still do this,
  151. however.
  152.  
  153. During operation, you can use the keyboard as you would when running Jove on
  154. any other system. However, many commands also have menu equivalents:  as
  155. long as MacJove is waiting for a command, you can use either the keyboard or
  156. the menus. Once you begin selecting a command with either the menus or the
  157. keyboard, the other is locked out: thus, once you type control-X, MacJove
  158. expects more characters, and will not let you choose menu items.  Also, if
  159. you are prompted for input on the command line, the menus are locked out.
  160. Regardless of how a command